﻿/* 
* Copyright (c) 2010, The University of Texas at Austin
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, 
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, 
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, 
* this list of conditions and the following disclaimer in the documentation and/or other materials 
* provided with the distribution.
*
* Neither the name of The University of Texas at Austin nor the names of its contributors may be 
* used to endorse or promote products derived from this software without specific prior written 
* permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR 
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

using System.Collections.Generic;

namespace Bio.Data.Interfaces
{
    /// <summary>
    /// An enumeration of the different types of RNA secondary structure elements
    /// </summary>
    public enum StructureExtentType
    {
        Helix,
        Hairpin,
        Multistem,
        Bulge,
        Internal,
        Knot,
        Free,
        Tail
    }

    /// <summary>
    /// Represents an RNA secondary structure model extent, which can include different
    /// types of elements such as: helices, hairpin loops, internal loops, pseudoknots, motifs, etc...
    /// </summary>
    public interface IStructureExtentBioEntity
    {
        /// <summary>
        /// The structure extent identifier
        /// </summary>
        int ID { get; }

        /// <summary>
        /// For ordering extents within an element like a helix
        /// </summary>
        int Ordinal { get; }

        /// <summary>
        /// The type of the structure extent
        /// </summary>
        StructureExtentType Type { get; }

        /// <summary>
        /// Index of the first element in the extent
        /// </summary>
        int StartIndex { get; }

        /// <summary>
        /// Index of the last element in the extent
        /// </summary>
        int EndIndex { get; }

        /// <summary>
        /// List of the nucleotides in the extent
        /// </summary>
        IList<IBioSymbol> Elements { get; }
    }
}
